home *** CD-ROM | disk | FTP | other *** search
/ Personal Computer World 2005 October / PCWOCT05.iso / Software / FromTheMag / XAMPP 1.4.14 / xampp-win32-1.4.14-installer.exe / xampp / php / pear / docs / PhpDocumentor / Release-1.2.0 < prev    next >
Text File  |  2004-03-24  |  15KB  |  337 lines
  1. $Id: Release-1.2.0,v 1.1.2.10 2003/06/04 18:38:14 CelloG Exp $
  2.  
  3. PhpDocumentor Version 1.2.0 RELEASE CANDIDATE 2
  4. ################################################################################
  5. http://www.phpdoc.org
  6. Joshua Eichorn jeichorn@phpdoc.org
  7. Gregory Beaver cellog@users.sourceforge.net
  8. ################################################################################
  9. ################################################################################
  10.  
  11. The phpDocumentor team would like to announce the release of phpDocumentor
  12. 1.2.0 FINAL.  All known bugs have been fixed.  This release is ready for use in
  13. production environments, and is a massive improvement in both features and
  14. stability over 1.1.0 FINAL.
  15.  
  16. Note that the license of phpDocumentor 1.2.0 is different from phpDocumentor 1.1.0.
  17. phpDocumentor 1.2.0 is under the PHP License version 3.0, full text is in
  18. PHPLICENSE.txt
  19.  
  20. for PEAR programmers, the new --pear command-line switch will be a boon.  Leave
  21. it on by default if your package follows PEAR coding and directory naming standards
  22.  
  23. ------
  24. IMPORTANT: phpDocumentor 1.2.0 requires PHP version 4.1.0 or greater.
  25. phpDocumentor will function best with PHP version 4.3.0 or greater, as it will
  26. use of the tokenizer extension if php 4.3.0 is installed for a tremendous
  27. increase in parsing speed.
  28. ------
  29.  
  30. phpDocumentor is a JavaDoc-like automatic documentation generator for PHP
  31. written in PHP.  It is the most versatile tool for documenting PHP.
  32.  
  33. Once again, phpDocumentor brings a great increase in usability with the 1.2
  34. branch.  The addition of a tokenizer-based parser increases parsing speed by
  35. up to 4 times (that's 400% faster) compared to previous versions.  In addition,
  36. scalability has been improved, allowing generation of documents in multiple
  37. output formats with one command.  The usage of config files makes repetitive
  38. parsing tasks straightforward and reduces the chance for error.
  39.  
  40. The addition of DocBlock templates, extended documentation (tutorials) parsing,
  41. and many other new features make this release the most useful automatic
  42. documentor for any programming language.
  43.  
  44. The default HTML Converter has been ported to a new Smarty-based converter,
  45. HTMLframesConverter, and all of the old templates have been ported to the new
  46. Smarty-based format.  The HTMLdefaultConverter has been deprecated since its
  47. functionality is redundant.  Due to the time it takes to convert a template to
  48. the new format, the phpDocumentor team extends an offer to do this conversion
  49. for anyone who has a brand new template.  We may also include the template in a
  50. future release, if permission is granted.
  51.  
  52. Due to interest from PEAR programmers, there is a new beta-quality XML:DocBook
  53. converter with peardoc2 templates.  This converter could also generate other
  54. DocBook formats, if desired, but does not generate indexing for this release.
  55.  
  56. The PDF Converter has stepped up to beta-quality, is fully templatable, and
  57. has most bugs completely fixed.  The CHM converter has also taken major strides
  58. and is beta quality.
  59.  
  60. As predicted, the Smarty template engine is the primary template engine for
  61. all converters.
  62.  
  63. For users new to phpDocumentor, phpDocumentor uses an event-driven parser
  64. and intermediary data structures that allow it to perform at a level other
  65. automatic documentors for PHP cannot achieve:
  66.   --parsing any php file, with multiple classes and functions in the same file
  67.   --fully compliant with even the most esoteric php syntax 
  68.       ($string = <<< EOF, for example)
  69.   --ability to generate multiple output formats
  70.   --extremely fast parsing
  71.   --error/warnings by line number and file to allow for debugging of
  72.     documentation tags
  73.   --multiple output templates to easily customize the look of generated
  74.     documentation
  75.   --extensive documentation of the package, including a detailed specification
  76.     for tags and the included template engine
  77.   --open source, GPL
  78.   
  79.  
  80. A full listing of all closed bugs and feature requests can be found in the 
  81. next section of the notes
  82.  
  83. phpDocumentor 1.2.0 ready for production use documenting any PHP project,
  84. download it and try the most advanced solution for PHP documentation
  85. today.
  86.  
  87. ################################################################################
  88.  
  89. The following bugs are fixed in version 1.2.0
  90.  [ 729841 ] Source code only for certain file if same name used
  91.  [ 730081 ] --ignore-tags docs unclear
  92.  [ 730214 ] weird filesource
  93.  [ 731560 ] docbuilder include error on linux
  94.  [ 731750 ] Links to unparsed includes shown
  95.  [ 732900 ] ordered list messes up
  96.  [ 733100 ] phpdoc's help output shows 2 times option "quiet"
  97.  [ 733352 ] optional description parameter in @license tag
  98.  [ 732642 ] DocBook support broken/incomplete.
  99.  [ 735697 ] the web interface
  100.  [ 736832 ] Fatal error in phpDocumentorTParser.inc
  101.  [ 739740 ] Page-level docs are not generated without a @package tag
  102.  [ 740859 ] @uses in docblock template crashes parser
  103.  [ 740871 ] crash in DocBlockTags.inc line 99
  104.  [ 741887 ] case-sensitivity bug
  105.  [ 744026 ] @uses breaks on Classes.inc
  106.  [ 744028 ] {@link $el, $notfound} returns blank text
  107.  [ 746674 ] phpedit - vars, methods
  108.  [ 746690 ] DocBlocks not parsed for require_once statements
  109.  [ 746692 ] makedoc.sh $TITLE bug
  110.  [ 747733 ] cannot use same filename + different path in @example
  111.  [ 748314 ] --pear on php4/pear uses . as dirname
  112.  [ 748837 ] @uses with spaces
  113.  [ 748850 ] {@link} documentation is unclear
  114.  
  115. The following bugs are fixed in version 1.2.0RC2
  116.  [ 708928 ] write permissions needed on some program dirs
  117.  [ 723230 ] warning on line 1391, HighlightParser
  118.  [ 723320 ] @param output behaves funny
  119.  [ 723767 ] space needed after @param type $var
  120.  [ 723947 ] RIC parsing not reading the correct README
  121.  [ 724415 ] Non-package references not always resolved
  122.  [ 724417 ] Multi-level method references not linked
  123.  [ 724701 ] conflicting package names, inherited links fails to show up
  124.  [ 724857 ] @link URL text broken
  125.  [ 725247 ] Wrong list handling in peardoc converter
  126.  [ 725745 ] HTML:Smarty:* not creating ric_README.html
  127.  [ 725161 ] File view displays class symbols without names
  128.  [ 725788 ] if --packageoutput excludes files with classes
  129.  [ 725742 ] code tag alignment
  130.  [ 726195 ] Formatting tags breaks lists
  131.  [ 726313 ] Changelog not linked
  132.  [ 727823 ] "#@+"-block quirck?
  133.  [ 728585 ] static keyword
  134.  [ 728167 ] HTML tags are case sensitive
  135.  
  136. The following bugs are fixed in version 1.2.0RC1
  137.  [ 566663 ] @param &$arg broken
  138.  [ 657041 ] {@source} doesn't work right
  139.  [ 675871 ] --pear breaks if not a pear repository
  140.  [ 678176 ] Inherited vars/methods in HTML:frames:phpedit
  141.  [ 680652 ] Optional method/function parameters
  142.  [ 681459 ] {@internal}} not quite working
  143.  [ 681463 ] {@source} drops characters
  144.  [ 681735 ] {@source} in sdesc needs warning
  145.  [ 682490 ] {@internal}} not parsed right by highlightparser
  146.  [ 682491 ] multi-line description fubared in @tag
  147.  [ 687091 ] special characters not encoded
  148.  [ 687364 ] highlightparser $class->member incorrect
  149.  [ 687403 ] {@source} leaves "}"
  150.  [ 689874 ] is_a is not avaliable in PHP 4.1.0
  151.  [ 689893 ] Warnings on PHP 4.1.0
  152.  [ 689894 ] getincludevalue() missing argument 2 warning
  153.  [ 692522 ] @uses is screwy
  154.  [ 693213 ] tutorials post-processed twice
  155.  [ 693215 ] {@internal}} on single line not working
  156.  [ 694448 ] PKZip has bug, use winzip (not phpDocumentor bug)
  157.  [ 694594 ] PEAR mode: destructor image not shown by phpedit template
  158.  [ 694742 ] PDF converter has no table of contents
  159.  [ 695291 ] link to todo disappears in HTML:Smarty:*
  160.  [ 695482 ] @uses not checking for @access private
  161.  [ 695622 ] HTML:Smarty:* has no package-level docs
  162.  [ 696883 ] <code> in description crashes parser
  163.  [ 697156 ] PHP Warning with PDF Converter
  164.  [ 697656 ] putting a <code> inside a <li> turns it into a literal
  165.  [ 698417 ] {@link element descrip} wrong
  166.  [ 697644 ] parse fails if unmatched html tag, or text outside <li> list
  167.  [ 698468 ] Fatal error when inline tag across two lines
  168.  [ 698356 ] {@internal} not working properly
  169.  [ 701199 ] extra br in @filesource generation
  170.  [ 702549 ] --quiet option not valid?
  171.  [ 705897 ] HTML:frames:earthli misses Page.gif
  172.  [ 708560 ] intelligent list handling isn't quite working
  173.  [ 708559 ] @category tag not really working
  174.  [ 710366 ] <i>-Tag is ignored
  175.  [ 710700 ] empty defaultpackagename = caused busy loop
  176.  [ 711569 ] Fatal Error: Undefined Method during write
  177.  [ 712704 ] HTML:Smarty:* drops class level author information
  178.  [ 708914 ] <var>, <samp>, <kbd> broken
  179.  [ 713201 ] variable variables are not parsed properly in @global
  180.  [ 713954 ] @param type $var when &$var broken
  181.  [ 715077 ] HighlightParser needs @tag object classname support
  182.  [ 715084 ] HighlightParser craps out after $var->
  183.  [ 715452 ] @example doesn't work with anything other than .php
  184.  [ 718253 ] Using 'parent' in @example file causes crash
  185.  
  186. The following bugs are fixed in version 1.2.0BETA3
  187.  [ 661317 ] PDF converter in subpackage ids broken
  188.  [ 669945 ] CHM: "undefined function: convert()" with multiple outputs 
  189.  [ 670205 ] inherited methods have no links
  190.  [ 670341 ] <pre> in docblock doesn't htmlentitie
  191.  [ 670350 ] left_frame.tpl missing package level doc link
  192.  [ 670440 ] Io::getBase() is buggy
  193.  [ 670903 ] inline desc <code> not <pre>-ized
  194.  [ 671620 ] warning in Parser line 2271
  195.  [ 672149 ] @desc broken
  196.  [ 674053 ] Support for require_once 
  197.  [ 674059 ] requires PHP version 4.2 or higher
  198.  [ 674075 ] Bad @param kills parser
  199.  [ 677105 ] unbalanced HTML-comments in output of HTML:frames:phpedit
  200.  [ 677821 ] define not parsed right in highlightparser
  201.  [ 677822 ] {@source} not showing whole source
  202.  [ 677826 ] nonsense @link in @see breaks HTML output
  203.  [ 677938 ] whitespace wrong after certain docblocks
  204.  
  205. The following bugs are fixed in version 1.2.0BETA2
  206.  [ 665707 ] Warnings and errors in new_phpdoc.php
  207.  [ 666307 ] whitespace not ignored in @param
  208.  [ 669132 ] "no @package tag was used" error but @ignore & @package used
  209.  [ 669525 ] {$children[kids].sdesc} contains parent sdesc
  210.  [ 669613 ] Call to undefined function: getclassleft()
  211.  [ 669615 ] methods disapper
  212.  [ 669640 ] javadocdesc broken
  213.  [ 669909 ] PDF text starts off left side of page when have package.html
  214.  
  215. The following bugs are fixed in version 1.2.0BETA1a
  216.  [ 661976 ] @see broken
  217.  [ 662630 ] {} delimited variables within strings mess up the parser
  218.  [ 663435 ] define values, global variable values need htmlentities
  219.  [ 664058 ] @param not displayed in HTMLframesConverter 
  220.  
  221. The following bugs are fixed in version 1.2.0BETA1
  222.  
  223.  [ 586357 ] ignore a directory
  224.  [ 637921 ] sorting is weird with multiple package
  225.  [ 637928 ] multiple converters legal, but fails
  226.  [ 638042 ] two declarations of checkstate()
  227.  [ 638128 ] commandline win32 fails, w/relative path
  228.  [ 639553 ] new_phpdoc.php fails with php 4.2.3
  229.  [ 640507 ] constructor links broken
  230.  [ 641076 ] second instance of loop fails
  231.  [ 641235 ] need trim of -f and -d commandline
  232.  [ 641334 ] parse <script language="php"> as <?php
  233.  [ 642427 ] Incorrect Anchor link from elementIndex
  234.  [ 645588 ] elements named "function.." or "global.." don't link
  235.  [ 646281 ] {@link mailto:e@a descrip} broken
  236.  [ 647494 ] {@link element1, element2} incorrect
  237.  [ 648684 ] links to global vars, defines in Smarty wrong
  238.  [ 649646 ] comments not parsed in function
  239.  [ 649953 ] phpdoc command-line only runs from install dir
  240.  [ 650946 ] link to phpdoc.org new window
  241.  [ 651837 ] getLink broken in rare case
  242.  [ 653627 ] @staticvar broken
  243.  [ 654429 ] tutorial prev/next links not working
  244.  [ 655372 ] smarty template not found in pdf convers
  245.  [ 657041 ] {@source} doesn't work right
  246.  [ 657387 ] parent/child tutorials converted twice
  247.  [ 657726 ] used by link htmlentitiezed
  248.  [ 657739 ] need separate categories of {@tags}
  249.  [ 657934 ] subtrees not processed in Converter
  250.  [ 658120 ] PDF define template has bug
  251.  [ 658121 ] PDF Converter not passing elements sorte
  252.  [ 661316 ] @tutorial tutorial.ext#subsection.section broken
  253.  
  254. There of course were other small bugs fixed, these were just the bugs with 
  255. entries in source forge.  You can view the bug details or reopen it if
  256. you think it's not totally fixed at:
  257. http://sourceforge.net/tracker/?group_id=11194&atid=111194
  258.  
  259. Features added that had Feature Request entries in SF for 1.2.0:
  260.  [ 748419 ] Provide different tag variable types for template use
  261.  
  262. Features added that had Feature Request entries in SF for 1.2.0 rc 2:
  263.  [ 704808 ] command-line switch for template directory/converter directory
  264.  [ 722987 ] Relative example files
  265.  
  266. Features added that had Feature Request entries in SF for 1.2.0 rc 1:
  267.  [ 681470 ] Add syntax highlighting for <programlisting role="php"> 
  268.  [ 682810 ] Xref
  269.  [ 683101 ] starting/ending line numbers of docblocks/classes/methods
  270.  [ 687366 ] phpEdit-style list support
  271.  [ 695621 ] link to section of @filesource from each element
  272.  [ 714025 ] @license tag
  273.  
  274. Features added that had Feature Request entries in SF for 1.2.0 beta 3:
  275.  [ 674470 ] output a list of all @todos
  276.  [ 675194 ] -cp for converter-specific dynamic params 
  277.  
  278. Features added that had Feature Request entries in SF for 1.2.0 beta 2:
  279.  [ 650251 ] @filesource tag 
  280.  [ 670184 ] @example tag 
  281.  [ 670189 ] @internal/{@internal}} 
  282.  [ 670190 ] --ignore-tags command-line 
  283.  
  284. Features added that had Feature Request entries in SF for 1.2.0 beta 1a:
  285.  [ 663436 ] --title available in all pages, html
  286.  [ 663437 ] error if @package is missing 
  287.  [ 663439 ] PEAR command-line switch 
  288.  
  289. Features added that had Feature Request entries in SF for 1.2.0 beta 1:
  290.  
  291.  [ 541896 ] Create an Extended Howto
  292.  [ 558118 ] add {@inheritDoc}
  293.  [ 562604 ] Using @access blocs (_start ... _end)
  294.  [ 564991 ] auto-links to php manual
  295.  [ 566942 ] add {@link seeelement descrip}
  296.  [ 569746 ] make Program_root/ template thing
  297.  [ 577714 ] have master directory option
  298.  [ 586401 ] @access protected
  299.  [ 608603 ] REQUEST:class/function usage information
  300.  [ 615419 ] manuals like "php.net manual"
  301.  [ 623055 ] Zend IDE suport
  302.  [ 634518 ] inherit @author, @version, @copyright
  303.  [ 634589 ] @uses element
  304.  [ 634641 ] A way to document form variables
  305.  [ 635184 ] update all templates to phphtmllib
  306.  [ 637409 ] {keyword} - {data} pairs not flexible
  307.  [ 637660 ] parse type|type
  308.  [ 637920 ] simple way to extend a converter
  309.  [ 642235 ] Index of phphtmllib template
  310.  [ 645775 ] line numbers for elements
  311.  [ 651275 ] tutorials
  312.  [ 651716 ] automatically find README/INSTALL
  313.  [ 651723 ] @tutorial/{@tutorial}
  314.  [ 653608 ] allow the /user ini dir to be configable 
  315.  
  316. ################################################################################
  317.  
  318. The documentation has been updated for this release you can view it at
  319. http://phpdocu.sourceforge.net/spec/
  320. or in the distribution in the spec directory
  321.  
  322. The changelog is available in the tarball, or online at 
  323. http://phpdocu.sourceforge.net/Changelog
  324.  
  325. You can download the newest version from 
  326. http://phpdocu.sourceforge.net/downloads.php
  327.  
  328. And of course you can reach the webpage at http://phpdocu.sourceforge.net/ or 
  329. http://phpdoc.org/ 
  330.  
  331. enjoy
  332. -joshua eichorn <jeichorn@phpdoc.org>
  333. -gregory beaver <cellog@users.sourceforge.net>
  334.  
  335.  
  336. vim: set expandtab :
  337.